API Documentation
Classes | Public Member Functions | List of all members
nkWinUi::FileExplorer Class Referenceabstract

A graphical file explorer. More...

Inheritance diagram for nkWinUi::FileExplorer:
nkWinUi::Component nkExport::Exportable

Classes

class  FileFilter
 Used to filter files in the interface. More...
 

Public Member Functions

 FileExplorer ()
 
 ~FileExplorer ()
 
void addFilter (const std::string_view &label, const std::string_view &extension)
 
FileFiltergetFilter (unsigned int index)
 
void setFilter (unsigned int index, const std::string_view &label, const std::string_view &extension)
 
void setFollowSelfDir (bool value)
 
bool getFollowSelfDir () const
 
void setCurrentDir (const std::string_view &path)
 
const char * getCurrentDir () const
 
virtual std::string openDialog (bool forSave)=0
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical file explorer.

Constructor & Destructor Documentation

◆ FileExplorer()

nkWinUi::FileExplorer::FileExplorer ( )

Constructor.

◆ ~FileExplorer()

nkWinUi::FileExplorer::~FileExplorer ( )

Destructor.

Member Function Documentation

◆ addFilter()

void nkWinUi::FileExplorer::addFilter ( const std::string_view &  label,
const std::string_view &  extension 
)

Adds a filter to the exploring.

Parameters
labelThe label to designate the filter.
extensionThe extension the filter will filter.

◆ getFilter()

FileFilter& nkWinUi::FileExplorer::getFilter ( unsigned int  index)

Gets a set filter.

Parameters
indexThe index of the filter to retrieve.
Returns
The filter at given index, if available. If out of bounds, the last filter is returned.

◆ setFilter()

void nkWinUi::FileExplorer::setFilter ( unsigned int  index,
const std::string_view &  label,
const std::string_view &  extension 
)

Change the filter at given index.

Parameters
indexThe index of the filter to change.
labelThe label to set for the filter.
extensionThe extension to use for the filter.

◆ setFollowSelfDir()

void nkWinUi::FileExplorer::setFollowSelfDir ( bool  value)

Sets whether the explorer should keep track of its directory or not.

Parameters
valueIf the tracking should occur (true) or not (false).

◆ getFollowSelfDir()

bool nkWinUi::FileExplorer::getFollowSelfDir ( ) const
Returns
Whether this component tracks its active folder (true) or not (false).

◆ setCurrentDir()

void nkWinUi::FileExplorer::setCurrentDir ( const std::string_view &  path)

Sets the directory the explorer will start in.

Parameters
pathThe path the directory should use for its folder.

◆ getCurrentDir()

const char* nkWinUi::FileExplorer::getCurrentDir ( ) const
Returns
The current dir the explorer tracks.

◆ openDialog()

virtual std::string nkWinUi::FileExplorer::openDialog ( bool  forSave)
pure virtual

Opens the explorer dialog for file searching.

Parameters
forSaveWhether this dialog will be used to save a new file (true) or not (false).
Returns
The absolute path the user selected using the dialog.

◆ exportIntrospection()

virtual void nkWinUi::FileExplorer::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::FileExplorer::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: